# Table of Contents

1.  [About](#about)
2.  [Usage](#usage)
    1.  [Using GNU Guix](#usage-gnu-guix)
    2.  [Other ways](#usage-other)
3.  [Testing](#testing)
4.  [Dependencies](#dependencies)



<a id="about"></a>

# About

This project contains code for decrypting data files of Little Fighter 2.

The code is written in GNU Guile (`3.0.7`).


<a id="usage"></a>

# Usage

(project is still work-in-progress)


<a id="usage-gnu-guix"></a>

## Using GNU Guix

With GNU Guix installed, you can do the following:

1.  activate the specified GNU Guix environment:

        bash guix-env/env.sh

2.  run the program:

        guile -L . main.scm

The output should show a decrypted `stage.dat` file.


<a id="usage-other"></a>

## Other ways

All you need is a working GNU Guile installation to run the program. How you get
it, does not really matter. For example you could use your system package to
install GNU Guile, if it is available in your the package sources of your
system, or you could download the source code of GNU Guile and compile it for
your system.


<a id="testing"></a>

# Testing

You can run unit tests using the following command:

    guile -L . test/<TEST FILE>


<a id="dependencies"></a>

# Dependencies

The project depends on nothing except GNU Guile. It is tested using GNU Guile
`3.0.7`, but probably works using many older versions as well.
